DESCRIPTION:

Create an HttpRequest.

CALL:

obj = HttpRequest(method, url, varargin)

INPUT:

The http method, e.g. 'POST', 'GET' or 'PUT'
See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods

The destination url.

Parameter-value pairs corresponding to the HttpRequest properties.

OUTPUT:

Documentation for modelit.web.client.HttpRequest/HttpRequest
   doc modelit.web.client.HttpRequest

DESCRIPTION:

Evaluate a Matlab function remotely and asynchronously.

CALL:

varargout = feval_async(obj, fp_final, fp, varargin)

INPUT:

The function to be evaluated locally after the remote evaluation has finished.

The function to be evaluated remotely.

The arguments.

OUTPUT:

The outputs of the function evaluation.

EXAMPLE:

   h = modelit.web.client.HttpRequest('GET','http://localhost:4444')
 
   disp(sprintf('%d',10)) % where "sprintf('%d',10)" is executed remotely
   feval_async(h,@disp,@sprintf,'%d',10)

DESCRIPTION:

Evaluate a Matlab function remotely.

CALL:

varargout = feval(obj, fp, varargin)

INPUT:

The function to be evaluated remotely.

The arguments.

OUTPUT:

The outputs of the function evaluation.

EXAMPLE:

   h = modelit.web.client.HttpRequest('GET','http://localhost:4444')
   [tf,f] = feval(h,@find,[false, true])
 
   N=0;
   for k=1:100,
   N = N+(feval(h,@randn,1)>0);
   end
   disp(N)

DESCRIPTION:

Set username and password for authenticated request.

CALL:

obj = setCredentials(obj, username, password)

INPUT:

The username.

The password.

OUTPUT:

DESCRIPTION:

Set the milliseconds before a response timeout.

CALL:

obj = setTimeOut(obj, timeout)

INPUT:

Milliseconds before response timeout.

OUTPUT:

DESCRIPTION:

Set the milliseconds before a connection timeout.

CALL:

obj = setConnectTimeOut(obj, timeout)

INPUT:

Milliseconds before failover due to connection timeout.

OUTPUT:

DESCRIPTION:

Set the proxy address.

CALL:

obj = setProxy(obj, proxyAddress, proxyPort))

INPUT:

The proxy address.

The proxy port.

OUTPUT:

DESCRIPTION:

The http method, e.g. 'POST', 'GET' or 'PUT'

CALL:

obj = setMethod(obj, method)

INPUT:

The http method, e.g. 'POST', 'GET' or 'PUT'
See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods

OUTPUT:

DESCRIPTION:

Add one or more query parameters.

CALL:

obj = addParameters(obj, varargin)

INPUT:

parameter, value pairs. E.g. 'q', '1'

OUTPUT:

DESCRIPTION:

Set the query parameters. The query parameters are attached to the end of a url after the '?'. E.g. https://www.google.com/search?q=abstract.

CALL:

obj = setParameters(obj, parameters)

INPUT:

name-value pairs with the query parameters.

OUTPUT:

DESCRIPTION:

Add one or more request headers.

CALL:

obj = setUrl(obj, varargin)

INPUT:

header-value pairs, e.g. 'Content-Type', 'text/html'
See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers

OUTPUT:

DESCRIPTION:

Set the request headers. The HTTP headers can be used in an HTTP request to provide information about the request context.

CALL:

obj = setUrl(obj, url)

INPUT:

The request headers in name-value pairs.
See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers

OUTPUT:

DESCRIPTION:

Set the destination url.

CALL:

obj = setUrl(obj, url)

INPUT:

The destination url. e.g. https://www.httpbin.org/get

OUTPUT:

DESCRIPTION:

Set the contents of the request Body. This is the actual data to be sent to the endpoint.

CALL:

obj = setBody(obj, body)

INPUT:

The data of the request body.

OUTPUT:

DESCRIPTION:

Evaluate the Completed callback.

CALL:

callback(obj, event)

INPUT:

OUTPUT:

      no output

DESCRIPTION:

Add the callbacks defined in the Matlab object to the java object.

CALL:

obj = addCallbacks(obj)

INPUT:

OUTPUT:

callbacks defined in the Matlab object are added to the
java object.

DESCRIPTION:

Get the java object which extends the Callable interface.

CALL:

callable = getCallable(obj)

INPUT:

OUTPUT:

DESCRIPTION:

Set the callback to be executed when the client has received the complete response from the server.

CALL:

setProgressUpdatedCallback(obj, callback)

INPUT:

Use event.getProgress to get the progress (values
between 0 and 100).

OUTPUT:

DESCRIPTION:

Set the callback to be executed when the server returns an error.

CALL:

obj = setExceptionOccurredCallback(obj, callback)

INPUT:

Callback executed when the server returns an error.

OUTPUT:

DESCRIPTION:

Set the callback to be executed when the client starts sending the request.

CALL:

obj = setInitializedCallback(obj, callback)

INPUT:

Callback executed when the client start sending the
request. This is useful in combination with the
modelit.web.concurrent.ThreadPoolExecutor to detect when a submitted request is executed.

OUTPUT:

DESCRIPTION:

Set the callback to be executed when the client has received the complete response from the server.

CALL:

obj = setCompletedCallback(obj, callback)

INPUT:

Callback executed when the request has completed. i.e.
the complete response has been received. obj is a
modelit.web.client.HttpResponse

OUTPUT:

DESCRIPTION:

Send the request. This method is asynchronous when a CompletedCallback is specified.

CALL:

response = send(obj)

INPUT:

OUTPUT:

DESCRIPTION:

Assert that no error occured on remote computer.